Skip to main content

Request Password Reset API

POST /requestResetPassword​

Description​

This API endpoint allows users to initiate the password reset process by providing their email address. A reset password email containing further instructions will be sent to the specified email address if it is associated with an existing account.

Request Body​

The request utilizes GraphQL to perform the requestResetPassword mutation.

Mutation:​

mutation requestResetPassword ($email: String!) {
    requestResetPassword (email: $email)
}

Variables:​

{
  "email": "<User_Email_Address>"
}
  • email (String): The email address associated with the user's account for which the password reset is being requested.

Response:​

  • Success (200 OK):

    • If the email is successfully processed, no additional data is returned. The user will receive an email with instructions on how to reset their password.

  • Error (4XX/5XX):

    • Appropriate error messages and status codes will be returned in cases of invalid email, unregistered email address, or server errors.

Note:​

Ensure that the email address provided is valid and associated with an existing account on the platform. The user should check their inbox (and possibly the spam folder) for the password reset email.